API Documentation
Public Member Functions | List of all members
nkScripts::ScriptObjectReference Class Referencefinal

A reference over an object in the scripting environment. More...

Public Member Functions

 ScriptObjectReference ()
 
 ScriptObjectReference (ScriptObjectInterpreterReference *reference)
 
 ScriptObjectReference (const ScriptObjectView &other)
 
 ScriptObjectReference (const ScriptObjectReference &other)
 
 ScriptObjectReference (ScriptObjectReference &&other)
 
 ~ScriptObjectReference ()
 
ScriptObjectInterpreterReferencegetInterpreterReference () const
 
FUNCTION_PARAMETER_TYPE getType () const
 
ScriptObjectReferenceoperator= (const ScriptObjectView &other)
 
ScriptObjectReferenceoperator= (const ScriptObjectReference &other)
 
ScriptObjectReferenceoperator= (ScriptObjectReference &&other)
 

Detailed Description

A reference over an object in the scripting environment.

This class touches the reference counting in the environment, and can prevent an object from being freed. To avoid leak, external code should ensure this reference is only used when needed.

In theory, this class should never be altered by external code. Rather, it will be used as parameters for functions using it.

Constructor & Destructor Documentation

◆ ScriptObjectReference() [1/5]

nkScripts::ScriptObjectReference::ScriptObjectReference ( )

Default constructor.

◆ ScriptObjectReference() [2/5]

nkScripts::ScriptObjectReference::ScriptObjectReference ( ScriptObjectInterpreterReference reference)

Constructor from an interpreter specific reference.

Parameters
referenceThe reference to keep.

◆ ScriptObjectReference() [3/5]

nkScripts::ScriptObjectReference::ScriptObjectReference ( const ScriptObjectView other)

Constructor from a view over the data.

Parameters
otherThe view to construct the reference from.

◆ ScriptObjectReference() [4/5]

nkScripts::ScriptObjectReference::ScriptObjectReference ( const ScriptObjectReference other)

Copy constructor.

Parameters
otherThe reference to copy from.

◆ ScriptObjectReference() [5/5]

nkScripts::ScriptObjectReference::ScriptObjectReference ( ScriptObjectReference &&  other)

Move constructor.

Parameters
otherThe reference to take over.

◆ ~ScriptObjectReference()

nkScripts::ScriptObjectReference::~ScriptObjectReference ( )

Destructor.

Member Function Documentation

◆ getInterpreterReference()

ScriptObjectInterpreterReference* nkScripts::ScriptObjectReference::getInterpreterReference ( ) const
Returns
The interpreter specific reference data.

◆ getType()

FUNCTION_PARAMETER_TYPE nkScripts::ScriptObjectReference::getType ( ) const
Returns
The referenced script object type.

◆ operator=() [1/3]

ScriptObjectReference& nkScripts::ScriptObjectReference::operator= ( const ScriptObjectView other)

View assignment operator.

Parameters
otherThe view to construct a reference from.
Returns
The reference after operation.

◆ operator=() [2/3]

ScriptObjectReference& nkScripts::ScriptObjectReference::operator= ( const ScriptObjectReference other)

Copy assignment operator.

Parameters
otherThe reference to copy from.
Returns
The reference after operation.

◆ operator=() [3/3]

ScriptObjectReference& nkScripts::ScriptObjectReference::operator= ( ScriptObjectReference &&  other)

Move assignment operator.

Parameters
otherThe reference to move.
Returns
The reference after operation.

The documentation for this class was generated from the following file: